<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>XML Formatter Maven Plugin - xml-formatter:help</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            XML Formatter Maven Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2011-05-27
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="xml-formatter:help"></a>xml-formatter:help</h2>
<p><strong>Full name</strong>:</p>
<p>com.google.code.xml-formatter-maven-plugin:xml-formatter-maven-plugin:1.0-SNAPSHOT:help</p>
<p><strong>Description</strong>:</p>
<div>Display help information on xml-formatter-maven-plugin.<br />

 Call 

<pre>
  mvn xml-formatter:help -Ddetail=true -Dgoal=&lt;goal-name&gt;
</pre>

to display parameter details.</div><p><strong>Attributes</strong>:</p>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#detail">detail</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>If <code>true</code>, display all settable properties for each
goal.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#goal">goal</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The name of the goal for which to show help. If unspecified, all
goals will be displayed.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#indentSize">indentSize</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>The number of spaces per indentation level, should be positive.<br />
<strong>Default value is</strong>: <code>2</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#lineLength">lineLength</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>The maximum length of a display line, should be positive.<br />
<strong>Default value is</strong>: <code>80</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="detail">detail</a>:</strong></p>
<div>If <code>true</code>, display all settable properties for each
goal.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${detail}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="goal">goal</a>:</strong></p>
<div>The name of the goal for which to show help. If unspecified, all
goals will be displayed.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${goal}</code></li>
</ul>
<hr />
<p><strong><a name="indentSize">indentSize</a>:</strong></p>
<div>The number of spaces per indentation level, should be positive.</div><ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${indentSize}</code></li>
<li><strong>Default</strong>: <code>2</code></li>
</ul>
<hr />
<p><strong><a name="lineLength">lineLength</a>:</strong></p>
<div>The maximum length of a display line, should be positive.</div><ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${lineLength}</code></li>
<li><strong>Default</strong>: <code>80</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2011
    
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
